<html>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<link rel="stylesheet" href="../style.css" type="text/css" media="all" />
<body>
<h1>Module</h1>
<div class="class_description">Абстрактный родитель для объектов модулей</div>
<h2>Методы</h2><ul><li><a href="#detectFilters">detectFilters</a></li><li><a href="#expectSecureGET">expectSecureGET</a></li><li><a href="#extend">extend</a></li><li><a href="#flush">flush</a></li><li><a href="#getRealClassName">getRealClassName</a></li><li><a href="#getRequestData">getRequestData</a></li><li><a href="#getValidateErrors">getValidateErrors</a></li><li><a href="#isMethodExists">isMethodExists</a></li><li><a href="#setPageTitle">setPageTitle</a></li></ul><a name="detectFilters"></a>
<h3>detectFilters</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">void</span> <span class="name">detectFilters</span> (<span class="type">Type</span> <span class="varname">$oType</span>, <span class="type">Selection</span> <span class="varname">$selection</span>)</div><p>Добавляет фильтры в Selection, переданные в URI</p>
</div>
</div><div class="block parametrs">
<h4>Параметры</h4>
<div class="text parametrs"><dl class="var_description">
	<dt>oType</dt>
	<dd>тип, поля которого будут искаться в фильтрах</dd>
</dl>
</div>
</div><div class="block samples">
<h4>Примеры</h4><div class="sample">
<p>Пример №1</p>
<div class="sample_content"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br /><br /></span><span style="color: #FF8000">//&nbsp;URI&nbsp;=&nbsp;http://localhost/people/search?filter[city]=Moscow<br /><br />//&nbsp;...&nbsp;Объявление&nbsp;$sel&nbsp;...<br /><br /></span><span style="color: #0000BB">$oType&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">TypesController</span><span style="color: #007700">::</span><span style="color: #0000BB">getInstance</span><span style="color: #007700">()-&gt;</span><span style="color: #0000BB">getTypeByName&nbsp;</span><span style="color: #007700">(</span><span style="color: #DD0000">'user'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">detectFilters&nbsp;</span><span style="color: #007700">(</span><span style="color: #0000BB">$oType</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$sel</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">//&nbsp;В&nbsp;данном&nbsp;случае&nbsp;эквивалентно&nbsp;$sel-&gt;addFilter&nbsp;('city',&nbsp;'Moscow');<br /><br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
</div>
</div><a name="expectSecureGET"></a>
<h3>expectSecureGET</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">void</span> <span class="name">expectSecureGET</span> ()</div><p>Бросает исключение AccessException при неверном GET-параметре scode</p>
</div>
</div><a name="extend"></a>
<h3>extend</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">void</span> <span class="name">extend</span> (<span class="type">string</span> <span class="varname">$className</span>)</div><p>Подгружает заданных класс. При отсутствии вызванного метода у главного класса модуля будет вызван метод подгруженного класса</p>
</div>
</div><div class="block parametrs">
<h4>Параметры</h4>
<div class="text parametrs"><dl class="var_description">
	<dt>className</dt>
	<dd>имя класса, файл этого класса должен иметь такое же название и находиться в одной папке с текущим модулем</dd>
</dl>
</div>
</div><a name="flush"></a>
<h3>flush</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">void</span> <span class="name">flush</span> (<span class="type">mixed</span> <span class="varname">$content</span>, <span class="type">string</span> <span class="varname">$contentType</span> = 'text/html')</div><p>Отдает браузеру контент и заверщает программу</p>
</div>
</div><div class="block parametrs">
<h4>Параметры</h4>
<div class="text parametrs"><dl class="var_description">
	<dt>content</dt>
	<dd>контент</dd>
</dl><dl class="var_description">
	<dt>contentType</dt>
	<dd>тип контента</dd>
</dl>
</div>
</div><a name="getRealClassName"></a>
<h3>getRealClassName</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">string</span> <span class="name">getRealClassName</span> ()</div><p>Возвращает реальное название класса, где реализован заданный метод</p>
</div>
</div><a name="getRequestData"></a>
<h3>getRequestData</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">array</span> <span class="name">getRequestData</span> (<span class="type">integer</span> <span class="varname">$objectId</span>, <span class="type">Type</span> <span class="varname">$type</span>, <span class="type">boolean</span> <span class="varname">$bGetNotEditable</span> = false)</div><p>Возвращает массив значений полей, переданных POST запросом, относящихся к объекту</p><p><strong>Результат: </strong>массив: ключ - имя поля, значение - значение</p>	
</div>
</div><div class="block parametrs">
<h4>Параметры</h4>
<div class="text parametrs"><dl class="var_description">
	<dt>objectId</dt>
	<dd>id объекта</dd>
</dl><dl class="var_description">
	<dt>type</dt>
	<dd>тип</dd>
</dl><dl class="var_description">
	<dt>bGetNotEditable</dt>
	<dd>принимать значения полей, запрещенных для редактирования через форму</dd>
</dl>
</div>
</div><div class="block samples">
<h4>Примеры</h4><div class="sample">
<p>Пример №1</p>
<div class="sample_content"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br /><br />$oType&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">TypesController</span><span style="color: #007700">::</span><span style="color: #0000BB">getInstance</span><span style="color: #007700">()-&gt;</span><span style="color: #0000BB">getTypeName&nbsp;</span><span style="color: #007700">(</span><span style="color: #DD0000">'user'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$object&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">ObjectsController</span><span style="color: #007700">::</span><span style="color: #0000BB">getInstance</span><span style="color: #007700">()-&gt;</span><span style="color: #0000BB">getObject&nbsp;</span><span style="color: #007700">(</span><span style="color: #0000BB">$oType</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">123</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$aProperties&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getRequestData&nbsp;</span><span style="color: #007700">(</span><span style="color: #0000BB">123</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$oType</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$object</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">setProperties&nbsp;</span><span style="color: #007700">(</span><span style="color: #0000BB">$aProperties</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
</div>
</div><a name="getValidateErrors"></a>
<h3>getValidateErrors</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">array</span> <span class="name">getValidateErrors</span> (<span class="type">Object</span> <span class="varname">$object</span>)</div><p>Проверяет значения свойств объекта на соответствие полям определенного типа</p><p><strong>Результат: </strong>массив ошибок полей, где ключ - название поля</p>	
</div>
</div><a name="isMethodExists"></a>
<h3>isMethodExists</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">boolean</span> <span class="name">isMethodExists</span> (<span class="type">string</span> <span class="varname">$sMethodName</span>)</div><p>Проверяет, существует ли метод у данного модуля, учитывая множественное наследование</p>
</div>
</div><a name="setPageTitle"></a>
<h3>setPageTitle</h3>
<div class="block description">
<h4>Описание</h4>
<div class="text method_description">
<div class="prototype"><span class="return">void</span> <span class="name">setPageTitle</span> (<span class="type">string</span> <span class="varname">$sTitle</span>)</div><p>Устанавливает заголовок страницы</p>
</div>
</div></body>
</html>